docs: update graphile-llm README with standard header#1010
Merged
pyramation merged 1 commit intomainfrom Apr 19, 2026
Merged
Conversation
…ntation - Add centered logo and badge header matching sibling packages - Add table of contents, installation, plugins table, configuration - Document RAG queries with GraphQL examples - Add toggleable capabilities section
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the
graphile-llmREADME to match the standard header format used by sibling packages (graphile-search,graphile-postgis,graphile-connection-filter). Adds centered logo, CI/license/version badges, table of contents, installation section, plugins table, full configuration example, RAG query examples, and license section.No code changes — docs only.
Review & Testing Checklist for Human
graphile%2Fgraphile-llm%2Fpackage.json) resolves correctly once the package is published. It will show a broken badge until first npm publish.npm install graphile-llminstallation instruction is appropriate — the package is currently a workspace package and may not be on npm yet. Consider whether it should saypnpm add graphile-llmor note that it's a workspace dependency.Notes
ragQuery,embedText,enableRagtoggle,defaultChatCompleter) that were added in PR feat: add graphile-llm plugin — embedding, RAG, and text-to-vector for PostGraphile #1008. These features are new and the documentation reflects the current API surface.Link to Devin session: https://app.devin.ai/sessions/720693f565cc4b8fb4b198ddf75814cc
Requested by: @pyramation